Shape-Related Functions Applicable to Bitmap Shapes (IM: XG)

Inside Macintosh: QuickDraw GX Graphics /: Chapter 5 - Bitmap Shapes / Applying Functions Described Elsewhere to Bitmap Shapes

Shape-Related Functions Applicable to Bitmap Shapes
You can apply all of the functions described in the chapter "Shape Objects" in Inside Macintosh: QuickDraw GX Objects to bitmap shapes. These functions allow you to

manipulate the shape object that represents the bitmap shape--for example, you can copy, clone, cache, compare, and dispose of the bitmap shape
set the geometry, shape type, shape fill, and shape attributes of the bitmap shape
change the style, ink, and transform objects that are associated with the bitmap shape
manipulate the tags and owner count of the bitmap shape

Table 5-3 gives important bitmap-related information for a subset of the functions from the chapter "Shape Objects" in Inside Macintosh: QuickDraw GX Objects. Functions described in that chapter that do not appear in this list exhibit the same behavior when applied to bitmap shapes as they do when applied to other types of shapes.
Shape-related functions that exhibit special behavior when applied to bitmaps
Function name Action taken
GXChangedShape Notifies QuickDraw GX that you have directly edited the geometry of the bitmap (using the GXGetShapeStructure and GXLockShape functions). You should call this function when you directly edit any field of a bitmap geometry structure or when you edit the pixel values of a bitmap's pixel image.
GXCopyToShape Makes a copy of the bitmap shape, but does not copy the pixel image. Instead, the new bitmap shape references the same pixel image.
GXCopyDeepToShape Makes a copy of the bitmap shape, including a complete copy of the bitmap's pixel image. The copy of the pixel image is allocated in QuickDraw GX memory, regardless of where the original image was allocated.
GXEqualShape Determines if two bitmap shapes are equal--that is, their bitmap position, height, width, color space, color set, and color profile fields are equal, and their pixel images contain the same pixel values.
GXGetShapeSize Determines the amount of memory currently used by the bitmap shape, including the amount of QuickDraw GX memory currently used by the pixel image of the bitmap.
GXGetDefaultShape Returns a reference to the default bitmap shape. The default bitmap shape has 1 bit per pixel, 0 width, and 0 height.
GXGetShapeFill Returns the shape fill of the shape. The shape fill for bitmap shapes is always even-odd fill or no fill.
GXGetShapeStructure Returns a pointer to the geometry of the bitmap shape. You can use this function to determine the address of the pixel image, even if it is allocated in QuickDraw GX memory.
GXLockShape Loads the bitmap shape into memory and locks its geometry into a fixed memory location. If the pixel image is allocated in QuickDraw GX memory, it is loaded and locked as well.
GXNewShape Creates a bitmap shape with 0 width, 0 height, 32 bits per pixel and rgb32space color space.
GXSetShapeFill Sets the shape fill of the shape. You must always set the shape fill of a bitmap shape to even-odd fill or no fill.
GXSetShapeType Changes the shape type of the bitmap shape and converts the shape fill and geometry as appropriate.

Shape-related functions that exhibit special behavior when applied to bitmaps
Function name	Action taken
GXChangedShape	Notifies QuickDraw GX that you have directly edited the geometry of the bitmap (using the `GXGetShapeStructure` and `GXLockShape` functions). You should call this function when you directly edit any field of a bitmap geometry structure or when you edit the pixel values of a bitmap's pixel image.
GXCopyToShape	Makes a copy of the bitmap shape, but does not copy the pixel image. Instead, the new bitmap shape references the same pixel image.
GXCopyDeepToShape	Makes a copy of the bitmap shape, including a complete copy of the bitmap's pixel image. The copy of the pixel image is allocated in QuickDraw GX memory, regardless of where the original image was allocated.
GXEqualShape	Determines if two bitmap shapes are equal--that is, their bitmap position, height, width, color space, color set, and color profile fields are equal, and their pixel images contain the same pixel values.
GXGetShapeSize	Determines the amount of memory currently used by the bitmap shape, including the amount of QuickDraw GX memory currently used by the pixel image of the bitmap.
GXGetDefaultShape	Returns a reference to the default bitmap shape. The default bitmap shape has 1 bit per pixel, 0 width, and 0 height.
GXGetShapeFill	Returns the shape fill of the shape. The shape fill for bitmap shapes is always even-odd fill or no fill.
GXGetShapeStructure	Returns a pointer to the geometry of the bitmap shape. You can use this function to determine the address of the pixel image, even if it is allocated in QuickDraw GX memory.
GXLockShape	Loads the bitmap shape into memory and locks its geometry into a fixed memory location. If the pixel image is allocated in QuickDraw GX memory, it is loaded and locked as well.
GXNewShape	Creates a bitmap shape with 0 width, 0 height, 32 bits per pixel and `rgb32space` color space.
GXSetShapeFill	Sets the shape fill of the shape. You must always set the shape fill of a bitmap shape to even-odd fill or no fill.
GXSetShapeType	Changes the shape type of the bitmap shape and converts the shape fill and geometry as appropriate.